<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Percepio Trace Recorder: Trace Process APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Percepio Trace Recorder<span id="projectnumber">&#160;v4.10.3</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__trace__process__apis.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle"><div class="title">Trace Process APIs<div class="ingroups"><a class="el" href="group__trace__recorder__apis.html">Trace Recorder APIs</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gabe03734eec55f8aaa492f05916e40f62"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__process__apis.html#gabe03734eec55f8aaa492f05916e40f62">xTraceProcessRegister</a>(szName,  uxPriority,  pxProcessHandle)&#160;&#160;&#160;<a class="el" href="group__trace__object__apis.html#ga25d702dc46bb776c99c3ebd48f46c529">xTraceObjectRegister</a>(PSF_EVENT_PROCESS_CREATE, (void*)0, szName, uxPriority, (TraceObjectHandle_t*)(pxProcessHandle))</td></tr>
<tr class="memdesc:gabe03734eec55f8aaa492f05916e40f62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register process in the trace.  <br /></td></tr>
<tr class="separator:gabe03734eec55f8aaa492f05916e40f62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6ba5ee177a2a128ae08b618488fa7fb8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__process__apis.html#ga6ba5ee177a2a128ae08b618488fa7fb8">xTraceProcessRegisterWithoutHandle</a>(pvProcess,  szName,  uxPriority)&#160;&#160;&#160;<a class="el" href="group__trace__object__apis.html#gacd88161ed7cc325b7a343d9ec8fad34e">xTraceObjectRegisterWithoutHandle</a>(PSF_EVENT_PROCESS_CREATE, (void*)(pvProcess), szName, uxPriority)</td></tr>
<tr class="memdesc:ga6ba5ee177a2a128ae08b618488fa7fb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register process in the trace.  <br /></td></tr>
<tr class="separator:ga6ba5ee177a2a128ae08b618488fa7fb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafaad3b87f424dd34f759d004f8ed79d4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__process__apis.html#gafaad3b87f424dd34f759d004f8ed79d4">xTraceProcessUnregister</a>(xProcessHandle,  uxPriority)&#160;&#160;&#160;<a class="el" href="group__trace__object__apis.html#ga20b1def504b1c9b237c711b3aaa49e29">xTraceObjectUnregister</a>((TraceObjectHandle_t)(xProcessHandle), PSF_EVENT_PROCESS_DELETE, uxPriority)</td></tr>
<tr class="memdesc:gafaad3b87f424dd34f759d004f8ed79d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregister process from trace.  <br /></td></tr>
<tr class="separator:gafaad3b87f424dd34f759d004f8ed79d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa00ab9ddf97e42ec119785101122eea9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__process__apis.html#gaa00ab9ddf97e42ec119785101122eea9">xTraceProcessUnregisterWithoutHandle</a>(pvProcess,  uxPriority)&#160;&#160;&#160;<a class="el" href="group__trace__object__apis.html#ga304a75a1c8a64e02b0f8fe2355305555">xTraceObjectUnregisterWithoutHandle</a>(PSF_EVENT_PROCESS_DELETE, (void*)(pvProcess), uxPriority)</td></tr>
<tr class="memdesc:gaa00ab9ddf97e42ec119785101122eea9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregister process from trace.  <br /></td></tr>
<tr class="separator:gaa00ab9ddf97e42ec119785101122eea9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="gabe03734eec55f8aaa492f05916e40f62" name="gabe03734eec55f8aaa492f05916e40f62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabe03734eec55f8aaa492f05916e40f62">&#9670;&#160;</a></span>xTraceProcessRegister</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceProcessRegister</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">szName, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uxPriority, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">pxProcessHandle&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__trace__object__apis.html#ga25d702dc46bb776c99c3ebd48f46c529">xTraceObjectRegister</a>(PSF_EVENT_PROCESS_CREATE, (void*)0, szName, uxPriority, (TraceObjectHandle_t*)(pxProcessHandle))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Register process in the trace. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">szName</td><td>Name. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxPriority</td><td>Priority. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pxProcessHandle</td><td>Process handle.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga6ba5ee177a2a128ae08b618488fa7fb8" name="ga6ba5ee177a2a128ae08b618488fa7fb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6ba5ee177a2a128ae08b618488fa7fb8">&#9670;&#160;</a></span>xTraceProcessRegisterWithoutHandle</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceProcessRegisterWithoutHandle</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">pvProcess, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">szName, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uxPriority&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__trace__object__apis.html#gacd88161ed7cc325b7a343d9ec8fad34e">xTraceObjectRegisterWithoutHandle</a>(PSF_EVENT_PROCESS_CREATE, (void*)(pvProcess), szName, uxPriority)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Register process in the trace. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">pvProcess</td><td>Process. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">szName</td><td>Name. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxPriority</td><td>Priority.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gafaad3b87f424dd34f759d004f8ed79d4" name="gafaad3b87f424dd34f759d004f8ed79d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafaad3b87f424dd34f759d004f8ed79d4">&#9670;&#160;</a></span>xTraceProcessUnregister</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceProcessUnregister</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xProcessHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uxPriority&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__trace__object__apis.html#ga20b1def504b1c9b237c711b3aaa49e29">xTraceObjectUnregister</a>((TraceObjectHandle_t)(xProcessHandle), PSF_EVENT_PROCESS_DELETE, uxPriority)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Unregister process from trace. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xProcessHandle</td><td>Process handle. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxPriority</td><td>Priority.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaa00ab9ddf97e42ec119785101122eea9" name="gaa00ab9ddf97e42ec119785101122eea9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa00ab9ddf97e42ec119785101122eea9">&#9670;&#160;</a></span>xTraceProcessUnregisterWithoutHandle</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceProcessUnregisterWithoutHandle</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">pvProcess, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uxPriority&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__trace__object__apis.html#ga304a75a1c8a64e02b0f8fe2355305555">xTraceObjectUnregisterWithoutHandle</a>(PSF_EVENT_PROCESS_DELETE, (void*)(pvProcess), uxPriority)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Unregister process from trace. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">pvProcess</td><td>Process. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxPriority</td><td>Priority.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
  </ul>
</div>
</body>
</html>
